<>> Succubus Heart <<>
  >  Source Notes  <
(This document holds source information)

- Naming Conventions -

SuH / suh
	all Succubus Heart objects will prefix with this to ensure easy finding and reduce chances of overlapping with other mods. SuH will be used for single time instances like Quests while suh will be used for common instances like spell effects

.E.    = Effect
.S.    = Script
.sex.  = Sex Effect
.spell.= Succubus Spell
.T.    = Spell Trigger
.SET.  = Configurable Setting
.NPC.  = Non-Playable Character
.PC.   = Player Character
.PCS.  = Player Character Stat
.dyna. = Dynamic Script Element
	
- Other -

;ent/ and ;end/
	These are nodes I use in notepad++ and other text editors to create clamps for easy navigation
	
- Quests -

SuH_Main - Primary quest which handles MODupdate and Mod Events
	Functions...
	MODupdate() - Used to update mod values

SuH_SuQuest - Handles player tick for Succubus Effects
	Functions...
	
SuH_Anim - Handles animation triggers such as Seduction Spells
	Functions...
	
SuH_Fun - Handles functions used globally through the mod
	Functions...
	XPcalc
		int aPreset ; Preset number values (Overrides other values with defaults)
			0 = no preset
			1 = Mastery Sex Act
			2 = Consent Sex Act
			3 = Submit Sex Act
			4 = Consume Sperm
			5 = Consume Milk
		int aMOD ; Additional Multiplier (adds to eMOD / Effect Multiplier)
		int XPearn ; Additional XP earned (set as "0" to disable)
		int lvlS ; Value scale comparative to the player (Multiplies with player level / set as "0" to disable)
		int dReport : bool determining if to create a debug notification for the player
	HPcalc / MPcalc / SPcalc
		Actor Char ; Character to be effected
		int aPreset ; Preset number values (Overrides other values with defaults)
			0 = no preset
			1 = Mastery Sex Act
			2 = Consent Sex Act
			3 = Submit Sex Act
			4 = Consume Sperm
			5 = Consume Milk
		int PCin ; Bool - Is the player involved? Is Pet Involved? (0-no 1-yes 2-pet)
		int drainC ; Bool - is draining? (Deducing value / set to 0 for gain)
		int aMOD ; 
		int aEffect ; Overrides default drain effect
		int dReport ; Bool - Send Notification of event?
		
- Global Variables -

suh_MODversion - Tracks Version number

- Spells and Effects -

- Factions -

suh_tracker - used to capture and track NPCs primarily for SexLab integration